/*
 * FreeRTOS Kernel V11.1.0
 * Copyright (C) 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * SPDX-License-Identifier: MIT
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * https://www.FreeRTOS.org
 * https://github.com/FreeRTOS
 *
 */

#ifndef FREERTOS_CONFIG_H
#define FREERTOS_CONFIG_H

#ifdef __cplusplus
extern "C" {
#endif

#include <avr/io.h>

/*-----------------------------------------------------------
 * Application specific definitions.
 *
 * These definitions should be adjusted for your particular hardware and
 * application requirements.
 *
 * THESE PARAMETERS ARE DESCRIBED WITHIN THE 'CONFIGURATION' SECTION OF THE
 * FreeRTOS API DOCUMENTATION AVAILABLE ON THE FreeRTOS.org WEB SITE.
 *
 * See https://www.freertos.org/a00110.html.

 *----------------------------------------------------------*/

/* Delay definition - here, the user can choose which delay implementation is required.
 * The default is to change nothing. */
#define configUSE_PORT_DELAY 1

/* And on to the things the same no matter the AVR type... */
#define configUSE_PREEMPTION 1

#ifndef configUSE_TIME_SLICING
    // 如果关闭时间片自动切换，可以保证上下文切换只在某些“方便”的地方发生，降低栈溢出的可能性
    // 但是每个任务都必须及时交出控制权，让其他任务得以运行，否则实时性将无法满足。
    //
    // AVR 单片机没有像Cortex-M 单片机那样的两个SP 指针，当中断发生时，中断服务函数会直接使用
    // 被中断的任务栈。如果中断恰好发生在调用栈的底层，也就是任务栈空间最紧张的地方，就可能导致
    // 任务栈溢出。
    // 此外，ISR 本身所需的栈空间是比较少的，因为ISR 代码一般比较精简，只需要在栈上存储必要的
    // 现场保护寄存器和少量局部变量。
    // 但是触发时间片切换时，除了ISR 本身的栈以外，任务栈里还需要保存所有寄存器。
    // 因为RTOS 并不知道某个任务实际使用了哪些寄存器，所以只能全部保存，这会多占用至少32 字节空间。
    // 当时间片切换发生在最“不方便”的位置时，相比普通的ISR，更可能导致栈溢出。
    #define configUSE_TIME_SLICING 1
#endif

#define configCPU_CLOCK_HZ     ((uint32_t)F_CPU)  // This F_CPU variable set by the environment
#define configUSE_16_BIT_TICKS 1
// #define configTICK_TYPE_WIDTH_IN_BITS       TICK_TYPE_WIDTH_16_BITS

#define configMAX_PRIORITIES    3
#define configMAX_TASK_NAME_LEN 16

/* Set the stack depth type to be uint16_t, otherwise it defaults to StackType_t */
#define configSTACK_DEPTH_TYPE uint16_t

#ifndef configCHECK_FOR_STACK_OVERFLOW
    #define configCHECK_FOR_STACK_OVERFLOW 1
#endif

#define configUSE_TRACE_FACILITY 0

#ifndef configMINIMAL_STACK_SIZE
    #if configCHECK_FOR_STACK_OVERFLOW == 2
        // configCHECK_FOR_STACK_OVERFLOW == 2 时，需要额外16 字节栈空间用于检测栈溢出
        #define configMINIMAL_STACK_SIZE 92 + 16
    #else
        #define configMINIMAL_STACK_SIZE 92
    #endif
#endif

#define configUSE_TASK_NOTIFICATIONS          1
#define configTASK_NOTIFICATION_ARRAY_ENTRIES 1

#define configUSE_MUTEXES             1
#define configUSE_RECURSIVE_MUTEXES   1
#define configUSE_COUNTING_SEMAPHORES 1

#define configUSE_QUEUE_SETS             0
#define configUSE_APPLICATION_TASK_TAG   0
#define configUSE_MALLOC_FAILED_HOOK     1  // malloc 失败不一定是致命错误，比如剩余容量探测
#define configQUEUE_REGISTRY_SIZE        0
#define configSUPPORT_DYNAMIC_ALLOCATION 1
#define configSUPPORT_STATIC_ALLOCATION  1

#define configUSE_IDLE_HOOK     1
#define configIDLE_SHOULD_YIELD 1
#define configUSE_TICK_HOOK     0

/* Timer definitions. */
#define configUSE_TIMERS             1
#define configTIMER_TASK_PRIORITY    (configMAX_PRIORITIES - 2)  // 定时器任务的优先级设置成比最高低一级，通常就是和其他大部分任务一样位于中间
#define configTIMER_TASK_STACK_DEPTH 92
#define configTIMER_QUEUE_LENGTH     10

/* Set the following definitions to 1 to include the API function, or zero
to exclude the API function. */

/* Set the following INCLUDE_* constants to 1 to incldue the named API function,
 * or 0 to exclude the named API function.  Most linkers will remove unused
 * functions even when the constant is 1. */
#define INCLUDE_vTaskPrioritySet            1
#define INCLUDE_uxTaskPriorityGet           1
#define INCLUDE_vTaskDelete                 1
#define INCLUDE_vTaskSuspend                1
#define INCLUDE_xTaskResumeFromISR          1
#define INCLUDE_xTaskDelayUntil             1
#define INCLUDE_vTaskDelay                  1
#define INCLUDE_xTaskGetSchedulerState      0
#define INCLUDE_xTaskGetCurrentTaskHandle   1
#define INCLUDE_uxTaskGetStackHighWaterMark 1
#define INCLUDE_xTaskGetIdleTaskHandle      0
#define INCLUDE_eTaskGetState               0
#define INCLUDE_xEventGroupSetBitFromISR    1
#define INCLUDE_xTimerPendFunctionCall      0
#define INCLUDE_xTaskAbortDelay             0
#define INCLUDE_xTaskGetHandle              0

#define configMAX(a, b) ({ __typeof__ (a) _a = (a); __typeof__ (b) _b = (b); _a > _b ? _a : _b; })
#define configMIN(a, b) ({ __typeof__ (a) _a = (a); __typeof__ (b) _b = (b); _a < _b ? _a : _b; })

/**
 * configASSERT macro: https://www.freertos.org/a00110.html#configASSERT
 */
#ifndef configASSERT

    #ifndef configDEFAULT_ASSERT
        #ifdef NDEBUG
            #define configDEFAULT_ASSERT 0
        #else
            #define configDEFAULT_ASSERT 1
        #endif
    #endif

    /**
     * Define a hook method for configASSERT macro if configASSERT is enabled.
     */
    #if configDEFAULT_ASSERT == 1
extern void vApplicationAssertHook(void);

        #define configASSERT(x) \
            if ((x) == 0) vApplicationAssertHook()
    #endif

#endif

#ifdef __cplusplus
}
#endif


#if __has_include("FreeRTOS_UserConfig.h")

    // 可以在FreeRTOS_UserConfig.h 中undef 某些默认配置，然后重新定义
    #include "FreeRTOS_UserConfig.h"

#endif


#endif /* FREERTOS_CONFIG_H */
